home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / comm / infpop21.zip / SAMPLEDB.TXT < prev   
Text File  |  1992-06-05  |  7KB  |  171 lines
  1. ;SAMPLEDB.TXT - an InfoPop supplemental database
  2. ;
  3. ; This is a sample file you can use to guide you in the
  4. ; creation of a supplemental database for InfoPop. While
  5. ; you may not update the existing INFOPOP.HLP file, you
  6. ; may create an auxillary database that can be called into
  7. ; the InfoPop (IP) search engine at any time by pressing F3.
  8. ;
  9. ; File must end with the TXT extension. MakeInfo will
  10. ; convert the file and give the resulting database a
  11. ; HLP extension. You may have no more than 175 cross-links
  12. ; for a given topic. See entry # 6 below for more information
  13. ;
  14. ; A few pointers
  15. ;
  16. ; <-- you may have comments in this file, just be sure
  17. ;     you preceed any *comment* line with a semicolon in
  18. ;     the first character position, as you see done here
  19. ;
  20. ; For each topic you add, you must assign a TOPIC NUMBER.
  21. ; If you don't want that topic to appear in the initial window
  22. ; (the main index), follow the !TOPIC # line with !NOINDEX.
  23. ; Also note that MAKEINFO directives must begin with a ! in
  24. ; the first character position of a line. The following sample
  25. ; entry shows what you need to know about creating an entry
  26. ;
  27. ;=================
  28. ;!TOPIC 15 My Favorite Internet Destination                  [a]
  29. ;!INDEX                                                      [b]
  30. ;My favorite destination is reached via TELNET 99.999.999  [c]
  31. ;It is the central database for the 20CIA                 [d]
  32. ;=========
  33. ;
  34. ;first, the sample lines have been labelled at right (a thru d).
  35. ;The important features of each line are described below.
  36. ;
  37. ;[a] Note the ! in the first position. This indicates to MAKEINFO
  38. ;    that a compiler directive follows. In this particular case,
  39. ;    it is a new topic (number 15). You should group your topics
  40. ;    by number range (to ease subsequent re-editing), but be aware
  41. ;    that leaving large gaps will have a negative impact on the
  42. ;    size of your final *.HLP file. A large gap is 50 or more
  43. ;    unused numbers.  The number you assign to a topic is the
  44. ;    number you use subsequently to cross-reference it (make a
  45. ;    hyperlink.  You can see a link made in line [d].
  46. ;
  47. ;[b] This directive '!INDEX' tells MakeInfo to put this topic
  48. ;    on the opening menu of topics == what you get if you press
  49. ;    HOME when Infopop is running.  If you don't want the topic
  50. ;    to appear in the main topic, put !NOINDEX.  If you want
  51. ;    to force a topic to be first in the listing (MAKEINFO
  52. ;    defaults to an alphabetical listing of topics), put a
  53. ;    number after the !INDEX (e.g., !INDEX 1 would make it
  54. ;    first, !INDEX 5000 would make it last if you didn't have
  55. ;    more than 5000 topics
  56. ;
  57. ;[c] This line would be the first line of text in the window
  58. ;    associated with topic 15.  Note the 's...this highlights
  59. ;    the term (makes it appear bold). It doesn't establish a
  60. ;    hyper link, it just provides a mechanism for bolding
  61. ;    text.  You create that symbol by holding down the ALT key
  62. ;    as you press 2 on the keypad.  Be sure to put the ALT-2
  63. ;    mark at the start of bolding at at the end of the text
  64. ;    string you want to appear in bold!
  65. ;
  66. ;[d] This line shows how you make a hyperlink. First press the
  67. ;    ALT key, then the 4 on the keypad. That puts a  symbol
  68. ;    in the text. Follow that with the number of the topic
  69. ;    you want to reference.  Follow the number with a  (ALT-5)
  70. ;    then type the text you want to use to reference the
  71. ;    linked topic (doesn't have to be the same as the text
  72. ;    that follows the !TOPIC directive for the topic you're
  73. ;    linking to), then follow that text with another  (ALT-5).
  74. ;
  75. ;
  76. ;Use these directives at the start of any supplemental file:
  77. ;
  78. ;=========
  79. !WIDTH 77
  80. !NOWRAP
  81. !SCROLLING
  82. ;=========
  83. ;!WIDTH = width of text in window. If your line goes over that,
  84. ;         makeinfo will wrap it...unless of course you specify
  85. ;         !NOWRAP. I recommend you do, that way you can format
  86. ;         your text in the *.TXT file you use to create the
  87. ;         *.HLP file and it will appear just as you type it.
  88. ;         If you're going to draw a map or reproduce a screen
  89. ;         you really need the !NOWRAP directive.
  90. ;
  91. ;!SCROLLING = means you allow the user to scroll the window to see
  92. ;             text that won't fit in the window.
  93. ;
  94. ;What follows is a small sample file
  95. !TOPIC 1 About this database
  96. !INDEX 1
  97. This is a sample file that shows how you can create your own InfoPop
  98. supplemental database.  Be sure to read the SAMPLE.TXT file that
  99. was used to create this demo. It explains how you must write the
  100. file.
  101.  
  102. Note that you must use an 2ASCII editor to create a supplemental
  103. file. Then you must run it through 3MakeInfo to create the
  104. resulting *.HLP file that you can load into Infopop.
  105. ;=====
  106. !TOPIC 2 ASCII
  107. !NOINDEX
  108. Not a word processor...A really nice ASCII editor is QEDIT. Others
  109. that will work are BOXER, PC-WRITE, or perhaps even
  110. WordPerfect (just as long as you remember to save the file as
  111. an ASCII (DOS text) file (CTRL-F5)).  To test a particular
  112. editor, just press down the ALT key and type 179 on your
  113. keypad. If you get a │ symbol, then you're able to use the
  114. editor to generate INFOPOP databases.  No, the │ isn't required
  115. but it is a pretty fair test...you will have to enter ALT-4
  116. and ALT-5 to make the hyperlinking work...
  117.  
  118. ;====
  119. !TOPIC 3 MakeInfo
  120. !NOINDEX
  121. Makeinfo is a utility that will turn your *.TXT file into a database
  122. that 4InfoPop can read and use.  The ASCII text file will be
  123. converted to binary form and compressed.
  124. ;====
  125. ;
  126. ; Note in this case, there is no !INDEX directive. Omitting !NOINDEX
  127. ; will force this entry into the main index, displaying it in
  128. ; alphabetical order
  129. ;--------
  130. !TOPIC 4 InfoPop
  131. InfoPop (from 5GMUtant Software) is the whole point of this. IP.EXE
  132. (the program) is what you use as the hypertext search engine for
  133. your helpfile.
  134.  
  135. ;=======
  136. !TOPIC 5 GMUtant Software
  137.  
  138. InfoPop and MakeInfo are not public domain.  You may freely use,
  139. fcopy and distribute the InfoPop package, provided that you
  140. distribute all files contained in the archive. Any distribution
  141. of InfoPop must include: IP.EXE, INFOPOP.HLP, IP.DOC, MAKEINFO.EXE and
  142. SAMPLEDB.TXT.
  143.  
  144. You may create your own databases, compile them with MakeInfo
  145. and distribute them if you wish.
  146.  
  147. Author: Clyde W. Grotophorst
  148.  email: wallyg@fen1.gmu.edu
  149.  
  150. ;=====
  151. ;
  152. ; NOTE that you may have no more than 175 cross-references per
  153. ; topic. Thus, if you had more than 175 topics you would have
  154. ; to break your index up so that no one topic (in this case, the
  155. ; index), would be linked to more than 175 other topics or
  156. ; have more than 175 topics linked to it
  157. ;
  158. ;=======
  159. !TOPIC 6 Index
  160.  
  161. Here are the topics covered in this database.
  162.  
  163. 1About Sampledb
  164. 2ASCII
  165. 5GMUtant Software
  166. 4InfoPop
  167. 3MakeInfo
  168.  
  169.  
  170.  
  171.